Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / QuickZip Class / Zip Method / Zip(String,String,Boolean,Boolean,Boolean,Int64,SplitNameFormat,String[]) Method
The fully-qualified path and name of the zip file.
The password that will be used to encrypt the files.
Boolean value indicating if existing files should be overwritten.
Boolean value indicating if files contained within sub-folders should be added to the zip file.
Boolean value indicating if the directory structure should be preserved in the zip file.
The size, in bytes, of each split zip file part that will be created.
The naming convention the split zip file parts will follow.
The files to add to zipFileName. Can contain filemasks and folder names (ending with a backslash). All subfolders will also be scanned for the specified file(s), even if wildcards are not used, if recursive is set to true. For example, if "C:\test.txt" is specified, all "test.txt" files found on the "C:\" drive will be added to the zip file. Folders specified with the backslash after them will include their entire contents. Cannot be a null reference (Nothing in Visual Basic).


In This Topic
    Zip(String,String,Boolean,Boolean,Boolean,Int64,SplitNameFormat,String[]) Method
    In This Topic
    Adds files to a multi-part zip file using the specified split name format, the specified split size, an encryption password and specifying whether existing files will be overwritten and if the directory structure will be preserved.
    Syntax
    'Declaration
     
    Public Overloads Shared Sub Zip( _
       ByVal zipFileName As String, _
       ByVal encryptionPassword As String, _
       ByVal replaceExistingFiles As Boolean, _
       ByVal recursive As Boolean, _
       ByVal preservePaths As Boolean, _
       ByVal splitSize As Long, _
       ByVal splitNameFormat As SplitNameFormat, _
       ByVal ParamArray filesToZip() As String _
    ) 
    'Usage
     
    Dim zipFileName As String
    Dim encryptionPassword As String
    Dim replaceExistingFiles As Boolean
    Dim recursive As Boolean
    Dim preservePaths As Boolean
    Dim splitSize As Long
    Dim splitNameFormat As SplitNameFormat
    Dim filesToZip() As String
     
    QuickZip.Zip(zipFileName, encryptionPassword, replaceExistingFiles, recursive, preservePaths, splitSize, splitNameFormat, filesToZip)
    public static void Zip( 
       string zipFileName,
       string encryptionPassword,
       bool replaceExistingFiles,
       bool recursive,
       bool preservePaths,
       long splitSize,
       SplitNameFormat splitNameFormat,
       params string[] filesToZip
    )

    Parameters

    zipFileName
    The fully-qualified path and name of the zip file.
    encryptionPassword
    The password that will be used to encrypt the files.
    replaceExistingFiles
    Boolean value indicating if existing files should be overwritten.
    recursive
    Boolean value indicating if files contained within sub-folders should be added to the zip file.
    preservePaths
    Boolean value indicating if the directory structure should be preserved in the zip file.
    splitSize
    The size, in bytes, of each split zip file part that will be created.
    splitNameFormat
    The naming convention the split zip file parts will follow.
    filesToZip
    The files to add to zipFileName. Can contain filemasks and folder names (ending with a backslash). All subfolders will also be scanned for the specified file(s), even if wildcards are not used, if recursive is set to true. For example, if "C:\test.txt" is specified, all "test.txt" files found on the "C:\" drive will be added to the zip file. Folders specified with the backslash after them will include their entire contents. Cannot be a null reference (Nothing in Visual Basic).
    Remarks

    If zipFileName does not exist, it will be created and then the files will be added.

    Unicode and FileTimes extra headers are stored in the zip file when new items are added to the zip file. The extra headers of items that already exist in the zip file will not be modified.

    The EncryptionMethod.Compatible encryption method will be used with this overload.

    All zip files will automatically be created in the Zip64 zip file format if the limitations of the regular Zip format are reached.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also